.TH std::filesystem::filesystem_error::what 3 "2024.06.10" "http://cppreference.com" "C++ Standard Libary"
.SH NAME
std::filesystem::filesystem_error::what \- std::filesystem::filesystem_error::what

.SH Synopsis
   const char* what() const noexcept override;  \fI(since C++17)\fP

   Returns an explanatory byte string. This explanatory string contains the explanatory
   string passed at the time of construction. Implementations are encouraged to include
   the pathnames of path1() and path2() in native format and the
   std::system_error::what() string inside the returned string as well.

.SH Parameters

   \fI(none)\fP

.SH Return value

   A C-stye explanatory byte string that contains the explanatory string passed at the
   time of construction.

.SH Example


// Run this code

 #include <cstdio>
 #include <filesystem>
 #include <iostream>
 #include <string_view>
 namespace fs = std::filesystem;

 void explain(std::string_view note, fs::filesystem_error const& ex)
 {
     std::cout << note << " exception:\\n"
               << "what(): " << ex.what() << '\\n'
               << "path1(): " << ex.path1() << ", path2(): "
               << ex.path2() << "\\n\\n";
 }

 int main()
 {
     try
     {
         std::filesystem::rename("/dev", "/null");
     }
     catch(fs::filesystem_error const& ex)
     {
         explain("fs::rename()", ex);
     }

     for (auto const path : {"/bool", "/bin/cat", "/bin/mouse"})
         try
         {
             std::filesystem::create_directory(path);
         }
         catch(fs::filesystem_error const& ex)
         {
             explain("fs::create_directory()", ex);
         }
 }

.SH Possible output:

 fs::rename() exception:
 what(): filesystem error: cannot rename: Permission denied [/dev] [/null]
 path1(): "/dev", path2(): "/null"

 fs::create_directory() exception:
 what(): filesystem error: cannot create directory: Permission denied [/bool]
 path1(): "/bool", path2(): ""

 fs::create_directory() exception:
 what(): filesystem error: cannot create directory: File exists [/bin/cat]
 path1(): "/bin/cat", path2(): ""

 fs::create_directory() exception:
 what(): filesystem error: cannot create directory: Read-only file system [/bin/mouse]
 path1(): "/bin/mouse", path2(): ""
